<!DOCTYPE HTML>
<html>
	<head>
		<meta http-equiv="Content-Type" content="html/html; charset=utf-8" />
		<title>SFSUser Class Reference</title>
		<meta id="xcode-display" name="xcode-display" content="render"/>
		<link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" />
		<link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" />
		<meta name="generator" content="appledoc 2.2 (build 963)" />
	</head>
	<body>
		<header id="top_header">
			<div id="library" class="hideInXcode">
				<h1><a id="libraryTitle" href="../index.html">SFS2X API v1.3.7 </a></h1>
				<a id="developerHome" href="../index.html">gotoAndPlay() / A51 Integrated</a>
			</div>
			
			<div id="title" role="banner">
				<h1 class="hideInXcode">SFSUser Class Reference</h1>
			</div>
			<ul id="headerButtons" role="toolbar">
				<li id="toc_button">
					<button aria-label="Show Table of Contents" role="checkbox" class="open" id="table_of_contents"><span class="disclosure"></span>Table of Contents</button>
				</li>
				<li id="jumpto_button" role="navigation">
					<select id="jumpTo">
	<option value="top">Jump To&#133;</option>
	
	<option value="overview">Overview</option>
	
	
	
	
	<option value="tasks">Tasks</option>
	
	
	
	
	
	<option value="properties">Properties</option>
	
	<option value="//api/name/id">&nbsp;&nbsp;&nbsp;&nbsp;id</option>
	
	<option value="//api/name/isItMe">&nbsp;&nbsp;&nbsp;&nbsp;isItMe</option>
	
	<option value="//api/name/isPlayer">&nbsp;&nbsp;&nbsp;&nbsp;isPlayer</option>
	
	<option value="//api/name/isSpectator">&nbsp;&nbsp;&nbsp;&nbsp;isSpectator</option>
	
	<option value="//api/name/name">&nbsp;&nbsp;&nbsp;&nbsp;name</option>
	
	<option value="//api/name/playerId">&nbsp;&nbsp;&nbsp;&nbsp;playerId</option>
	
	<option value="//api/name/privilegeId">&nbsp;&nbsp;&nbsp;&nbsp;privilegeId</option>
	
	<option value="//api/name/properties">&nbsp;&nbsp;&nbsp;&nbsp;properties</option>
	
	<option value="//api/name/userManager">&nbsp;&nbsp;&nbsp;&nbsp;userManager</option>
	
	
	
	
	
	
	<option value="instance_methods">Instance Methods</option>
	
	<option value="//api/name/containsVariable:">&nbsp;&nbsp;&nbsp;&nbsp;- containsVariable:</option>
	
	<option value="//api/name/getPlayerId:">&nbsp;&nbsp;&nbsp;&nbsp;- getPlayerId:</option>
	
	<option value="//api/name/getVariable:">&nbsp;&nbsp;&nbsp;&nbsp;- getVariable:</option>
	
	<option value="//api/name/getVariables">&nbsp;&nbsp;&nbsp;&nbsp;- getVariables</option>
	
	<option value="//api/name/isAdmin">&nbsp;&nbsp;&nbsp;&nbsp;- isAdmin</option>
	
	<option value="//api/name/isGuest">&nbsp;&nbsp;&nbsp;&nbsp;- isGuest</option>
	
	<option value="//api/name/isJoinedInRoom:">&nbsp;&nbsp;&nbsp;&nbsp;- isJoinedInRoom:</option>
	
	<option value="//api/name/isModerator">&nbsp;&nbsp;&nbsp;&nbsp;- isModerator</option>
	
	<option value="//api/name/isPlayerInRoom:">&nbsp;&nbsp;&nbsp;&nbsp;- isPlayerInRoom:</option>
	
	<option value="//api/name/isSpectatorInRoom:">&nbsp;&nbsp;&nbsp;&nbsp;- isSpectatorInRoom:</option>
	
	<option value="//api/name/isStandardUser">&nbsp;&nbsp;&nbsp;&nbsp;- isStandardUser</option>
	
	
	
</select>
				</li>
			</ul>
		</header>
		<nav id="tocContainer" class="isShowingTOC">
			<ul id="toc" role="tree">
				
<li role="treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#overview">Overview</a></span></li>




<li role="treeitem" id="task_treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#tasks">Tasks</a></span><ul>
	
</ul></li>





<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#properties">Properties</a></span><ul>
	
	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/id">id</a></span></li>
	
	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isItMe">isItMe</a></span></li>
	
	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isPlayer">isPlayer</a></span></li>
	
	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isSpectator">isSpectator</a></span></li>
	
	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/name">name</a></span></li>
	
	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/playerId">playerId</a></span></li>
	
	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/privilegeId">privilegeId</a></span></li>
	
	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/properties">properties</a></span></li>
	
	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/userManager">userManager</a></span></li>
	
</ul></li>





<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#instance_methods">Instance Methods</a></span><ul>
	
	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/containsVariable:">containsVariable:</a></span></li>
	
	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/getPlayerId:">getPlayerId:</a></span></li>
	
	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/getVariable:">getVariable:</a></span></li>
	
	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/getVariables">getVariables</a></span></li>
	
	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isAdmin">isAdmin</a></span></li>
	
	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isGuest">isGuest</a></span></li>
	
	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isJoinedInRoom:">isJoinedInRoom:</a></span></li>
	
	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isModerator">isModerator</a></span></li>
	
	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isPlayerInRoom:">isPlayerInRoom:</a></span></li>
	
	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isSpectatorInRoom:">isSpectatorInRoom:</a></span></li>
	
	<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isStandardUser">isStandardUser</a></span></li>
	
</ul></li>


			</ul>
		</nav>
		<article>
			<div id="contents" class="isShowingTOC" role="main">
				<a title="SFSUser Class Reference" name="top"></a>
				<div class="main-navigation navigation-top">
					<ul>
	<li><a href="../index.html">Index</a></li>
	<li><a href="../hierarchy.html">Hierarchy</a></li>
</ul>
				</div>
				<div id="header">
					<div class="section-header">
						<h1 class="title title-header">SFSUser Class Reference</h1>
					</div>		
				</div>
				<div id="container">	
					
					<div class="section section-specification"><table cellspacing="0"><tbody>
						<tr>
	<td class="specification-title">Inherits from</td>
	<td class="specification-value">NSObject</td>
</tr><tr>
	<td class="specification-title">Conforms to</td>
	<td class="specification-value"><a href="../Protocols/User.html">User</a></td>
</tr><tr>
	<td class="specification-title">Declared in</td>
	<td class="specification-value">SFSUser.h<br />SFSUser.m</td>
</tr>
						</tbody></table></div>
					
                    
                    
					
					<div class="section section-overview">
						<a title="Overview" name="overview"></a>
						<h2 class="subtitle subtitle-overview">Overview</h2>
						<p>The SFSUser object represents a client logged in to the Server.</p>

<p>The client API doesn&rsquo;t know about all Users connected to the server side but only about those that are in the same Rooms where the client is joined.
In order to interact with other Users the client can join different Rooms or use a <BuddyList> to keep track of and interact with his/her friends.</p>
					</div>
					
					
					
					
					
					<div class="section section-tasks">
						<a title="Tasks" name="tasks"></a>
						<h2 class="subtitle subtitle-tasks">Tasks</h2>
						
						
						
						

						<ul class="task-list">
							<li>
	<span class="tooltip">
		<code><a href="#//api/name/id">&nbsp;&nbsp;id</a></code>
	</span>
	<span class="task-item-suffix">property</span>
	
</li><li>
	<span class="tooltip">
		<code><a href="#//api/name/playerId">&nbsp;&nbsp;playerId</a></code>
	</span>
	<span class="task-item-suffix">property</span>
	
</li><li>
	<span class="tooltip">
		<code><a href="#//api/name/privilegeId">&nbsp;&nbsp;privilegeId</a></code>
	</span>
	<span class="task-item-suffix">property</span>
	
</li><li>
	<span class="tooltip">
		<code><a href="#//api/name/name">&nbsp;&nbsp;name</a></code>
	</span>
	<span class="task-item-suffix">property</span>
	
</li><li>
	<span class="tooltip">
		<code><a href="#//api/name/isItMe">&nbsp;&nbsp;isItMe</a></code>
	</span>
	<span class="task-item-suffix">property</span>
	
</li><li>
	<span class="tooltip">
		<code><a href="#//api/name/properties">&nbsp;&nbsp;properties</a></code>
	</span>
	<span class="task-item-suffix">property</span>
	
</li><li>
	<span class="tooltip">
		<code><a href="#//api/name/isPlayer">&nbsp;&nbsp;isPlayer</a></code>
	</span>
	<span class="task-item-suffix">property</span>
	
</li><li>
	<span class="tooltip">
		<code><a href="#//api/name/isSpectator">&nbsp;&nbsp;isSpectator</a></code>
	</span>
	<span class="task-item-suffix">property</span>
	
</li><li>
	<span class="tooltip">
		<code><a href="#//api/name/userManager">&nbsp;&nbsp;userManager</a></code>
	</span>
	<span class="task-item-suffix">property</span>
	
</li><li>
	<span class="tooltip">
		<code><a href="#//api/name/getPlayerId:">&ndash;&nbsp;getPlayerId:</a></code>
	</span>
	
	
</li><li>
	<span class="tooltip">
		<code><a href="#//api/name/isGuest">&ndash;&nbsp;isGuest</a></code>
	</span>
	
	
</li><li>
	<span class="tooltip">
		<code><a href="#//api/name/isStandardUser">&ndash;&nbsp;isStandardUser</a></code>
	</span>
	
	
</li><li>
	<span class="tooltip">
		<code><a href="#//api/name/isModerator">&ndash;&nbsp;isModerator</a></code>
	</span>
	
	
</li><li>
	<span class="tooltip">
		<code><a href="#//api/name/isAdmin">&ndash;&nbsp;isAdmin</a></code>
	</span>
	
	
</li><li>
	<span class="tooltip">
		<code><a href="#//api/name/isPlayerInRoom:">&ndash;&nbsp;isPlayerInRoom:</a></code>
	</span>
	
	
</li><li>
	<span class="tooltip">
		<code><a href="#//api/name/isSpectatorInRoom:">&ndash;&nbsp;isSpectatorInRoom:</a></code>
	</span>
	
	
</li><li>
	<span class="tooltip">
		<code><a href="#//api/name/isJoinedInRoom:">&ndash;&nbsp;isJoinedInRoom:</a></code>
	</span>
	
	
</li><li>
	<span class="tooltip">
		<code><a href="#//api/name/getVariables">&ndash;&nbsp;getVariables</a></code>
	</span>
	
	
</li><li>
	<span class="tooltip">
		<code><a href="#//api/name/getVariable:">&ndash;&nbsp;getVariable:</a></code>
	</span>
	
	
</li><li>
	<span class="tooltip">
		<code><a href="#//api/name/containsVariable:">&ndash;&nbsp;containsVariable:</a></code>
	</span>
	
	
</li>
						</ul>
						
					</div>
					
					
					
					
					
					<div class="section section-methods">
						<a title="Properties" name="properties"></a>
						<h2 class="subtitle subtitle-methods">Properties</h2>
						
						<div class="section-method">
	<a name="//api/name/id" title="id"></a>
	<h3 class="subsubtitle method-title">id</h3>
	
	
	
	<div class="method-subsection brief-description">
		<p>Get the unique User Id</p>
	</div>		
	
    

	<div class="method-subsection method-declaration"><code>@property (nonatomic, assign) NSInteger id</code></div>

    
	
	
	
	
	
	
	
	<div class="method-subsection discussion-section">
		<h4 class="method-subtitle">Discussion</h4>
		<p>Get the unique User Id</p>
	</div>
	
	
	
	
	
	
	
	<div class="method-subsection declared-in-section">
		<h4 class="method-subtitle">Declared In</h4>
		<code class="declared-in-ref">SFSUser.h</code><br />
	</div>				
	
	
</div>
						
						<div class="section-method">
	<a name="//api/name/isItMe" title="isItMe"></a>
	<h3 class="subsubtitle method-title">isItMe</h3>
	
	
	
	<div class="method-subsection brief-description">
		<p>Return true if the User object is the client&rsquo;s User object, also known as SmartFox2XClient#mySelf</p>
	</div>		
	
    

	<div class="method-subsection method-declaration"><code>@property (nonatomic, readonly) BOOL isItMe</code></div>

    
	
	
	
	
	
	
	
	<div class="method-subsection discussion-section">
		<h4 class="method-subtitle">Discussion</h4>
		<p>Return true if the User object is the client&rsquo;s User object, also known as SmartFox2XClient#mySelf</p>
	</div>
	
	
	
	
	
	
	
	<div class="method-subsection declared-in-section">
		<h4 class="method-subtitle">Declared In</h4>
		<code class="declared-in-ref">SFSUser.h</code><br />
	</div>				
	
	
</div>
						
						<div class="section-method">
	<a name="//api/name/isPlayer" title="isPlayer"></a>
	<h3 class="subsubtitle method-title">isPlayer</h3>
	
	
	
	<div class="method-subsection brief-description">
		<p>Return true if the User is a Player (playerId &gt; 0) in the last joined Room
(non game Rooms will always return false)</p>
	</div>		
	
    

	<div class="method-subsection method-declaration"><code>@property (nonatomic, readonly) BOOL isPlayer</code></div>

    
	
	
	
	
	
	
	
	<div class="method-subsection discussion-section">
		<h4 class="method-subtitle">Discussion</h4>
		<p>Return true if the User is a Player (playerId &gt; 0) in the last joined Room
(non game Rooms will always return false)</p>
	</div>
	
	
	
	
	
	<div class="method-subsection see-also-section">
		<h4 class="method-subtitle">See Also</h4>
		<ul>
			
			<li><code><p>SmartFox2XClient#lastJoined<a href="../Protocols/Room.html">Room</a></p></code></li>
			
		</ul>
	</div>
	
	
	
	<div class="method-subsection declared-in-section">
		<h4 class="method-subtitle">Declared In</h4>
		<code class="declared-in-ref">SFSUser.h</code><br />
	</div>				
	
	
</div>
						
						<div class="section-method">
	<a name="//api/name/isSpectator" title="isSpectator"></a>
	<h3 class="subsubtitle method-title">isSpectator</h3>
	
	
	
	<div class="method-subsection brief-description">
		<p>Return true if the User is a Spectator (playerId &lt; 0) in the last joined Room
(non game Rooms will always return false)</p>
	</div>		
	
    

	<div class="method-subsection method-declaration"><code>@property (nonatomic, readonly) BOOL isSpectator</code></div>

    
	
	
	
	
	
	
	
	<div class="method-subsection discussion-section">
		<h4 class="method-subtitle">Discussion</h4>
		<p>Return true if the User is a Spectator (playerId &lt; 0) in the last joined Room
(non game Rooms will always return false)</p>
	</div>
	
	
	
	
	
	<div class="method-subsection see-also-section">
		<h4 class="method-subtitle">See Also</h4>
		<ul>
			
			<li><code><p>SmartFox2XClient#lastJoined<a href="../Protocols/Room.html">Room</a></p></code></li>
			
		</ul>
	</div>
	
	
	
	<div class="method-subsection declared-in-section">
		<h4 class="method-subtitle">Declared In</h4>
		<code class="declared-in-ref">SFSUser.h</code><br />
	</div>				
	
	
</div>
						
						<div class="section-method">
	<a name="//api/name/name" title="name"></a>
	<h3 class="subsubtitle method-title">name</h3>
	
	
	
	<div class="method-subsection brief-description">
		<p>The user name</p>
	</div>		
	
    

	<div class="method-subsection method-declaration"><code>@property (weak, nonatomic, readonly) NSString *name</code></div>

    
	
	
	
	
	
	
	
	<div class="method-subsection discussion-section">
		<h4 class="method-subtitle">Discussion</h4>
		<p>The user name</p>
	</div>
	
	
	
	
	
	
	
	<div class="method-subsection declared-in-section">
		<h4 class="method-subtitle">Declared In</h4>
		<code class="declared-in-ref">SFSUser.h</code><br />
	</div>				
	
	
</div>
						
						<div class="section-method">
	<a name="//api/name/playerId" title="playerId"></a>
	<h3 class="subsubtitle method-title">playerId</h3>
	
	
	
	<div class="method-subsection brief-description">
		<p>Get the <b>playerId</b> of the User.
The <b>playerId</b> is different from the User ID and it used to indicate which player number is the user inside a Game Room.
Example: in a Game Room for 5 players the first client joining will have <b>playerId = 1</b>, the 2nd will have <b>playerId = 2</b> and so forth.
When a User leaves the Room its player slot is freed up and the next User joining the Room will take it.</p>
	</div>		
	
    

	<div class="method-subsection method-declaration"><code>@property (nonatomic, readonly) NSInteger playerId</code></div>

    
	
	
	
	
	
	
	
	<div class="method-subsection discussion-section">
		<h4 class="method-subtitle">Discussion</h4>
		<p>Get the <b>playerId</b> of the User.
The <b>playerId</b> is different from the User ID and it used to indicate which player number is the user inside a Game Room.
Example: in a Game Room for 5 players the first client joining will have <b>playerId = 1</b>, the 2nd will have <b>playerId = 2</b> and so forth.
When a User leaves the Room its player slot is freed up and the next User joining the Room will take it.</p>

<p>The <b>playerId</b> is only applicable for Game Rooms, in the other Rooms it is always == 0
A playerId &lt; 0 indicates that the User is a spectator.</p>

<p>If the User is joined in multiple game Rooms at the same time he will be assigned one <b>playerId</b> per Room.</p>
	</div>
	
	
	
	
	
	
	
	<div class="method-subsection declared-in-section">
		<h4 class="method-subtitle">Declared In</h4>
		<code class="declared-in-ref">SFSUser.h</code><br />
	</div>				
	
	
</div>
						
						<div class="section-method">
	<a name="//api/name/privilegeId" title="privilegeId"></a>
	<h3 class="subsubtitle method-title">privilegeId</h3>
	
	
	
	<div class="method-subsection brief-description">
		<p>Get the privilegeId of the User</p>
	</div>		
	
    

	<div class="method-subsection method-declaration"><code>@property (nonatomic, assign) NSInteger privilegeId</code></div>

    
	
	
	
	
	
	
	
	<div class="method-subsection discussion-section">
		<h4 class="method-subtitle">Discussion</h4>
		<p>Get the privilegeId of the User</p>
	</div>
	
	
	
	
	
	<div class="method-subsection see-also-section">
		<h4 class="method-subtitle">See Also</h4>
		<ul>
			
			<li><code><p><a href="../Classes/UserPrivileges.html">UserPrivileges</a></p></code></li>
			
		</ul>
	</div>
	
	
	
	<div class="method-subsection declared-in-section">
		<h4 class="method-subtitle">Declared In</h4>
		<code class="declared-in-ref">SFSUser.h</code><br />
	</div>				
	
	
</div>
						
						<div class="section-method">
	<a name="//api/name/properties" title="properties"></a>
	<h3 class="subsubtitle method-title">properties</h3>
	
	
	
	<div class="method-subsection brief-description">
		<p>A generic object that can be used to store any User custom data needed at runtime.
The values added/removed in this object are for client side use only an are never transmitted to the Server.</p>
	</div>		
	
    

	<div class="method-subsection method-declaration"><code>@property (nonatomic, strong) NSMutableDictionary *properties</code></div>

    
	
	
	
	
	
	
	
	<div class="method-subsection discussion-section">
		<h4 class="method-subtitle">Discussion</h4>
		<p>A generic object that can be used to store any User custom data needed at runtime.
The values added/removed in this object are for client side use only an are never transmitted to the Server.</p>
	</div>
	
	
	
	
	
	
	
	<div class="method-subsection declared-in-section">
		<h4 class="method-subtitle">Declared In</h4>
		<code class="declared-in-ref">SFSUser.h</code><br />
	</div>				
	
	
</div>
						
						<div class="section-method">
	<a name="//api/name/userManager" title="userManager"></a>
	<h3 class="subsubtitle method-title">userManager</h3>
	
	
	
	<div class="method-subsection brief-description">
		<p>Get the UserManager of this User</p>
	</div>		
	
    

	<div class="method-subsection method-declaration"><code>@property (nonatomic, weak) id&lt;IUserManager&gt; userManager</code></div>

    
	
	
	
	
	
	
	
	<div class="method-subsection discussion-section">
		<h4 class="method-subtitle">Discussion</h4>
		<p>Get the UserManager of this User</p>
	</div>
	
	
	
	
	
	<div class="method-subsection see-also-section">
		<h4 class="method-subtitle">See Also</h4>
		<ul>
			
			<li><code><p><a href="../Classes/SFSUserManager.html">SFSUserManager</a></p></code></li>
			
		</ul>
	</div>
	
	
	
	<div class="method-subsection declared-in-section">
		<h4 class="method-subtitle">Declared In</h4>
		<code class="declared-in-ref">SFSUser.h</code><br />
	</div>				
	
	
</div>
						
					</div>
					
					
					
					
					
					<div class="section section-methods">
						<a title="Instance Methods" name="instance_methods"></a>
						<h2 class="subtitle subtitle-methods">Instance Methods</h2>
						
						<div class="section-method">
	<a name="//api/name/containsVariable:" title="containsVariable:"></a>
	<h3 class="subsubtitle method-title">containsVariable:</h3>
	
	
	
	<div class="method-subsection brief-description">
		<p>Check if a UserVariable exists</p>
	</div>		
	
    

	<div class="method-subsection method-declaration"><code>- (BOOL)containsVariable:(NSString *)<em>name</em></code></div>

    
	
	<div class="method-subsection arguments-section parameters">
		<h4 class="method-subtitle parameter-title">Parameters</h4>
		
		<dl class="argument-def parameter-def">
			<dt><em>name</em></dt>
			<dd><p>the name of the variable</p></dd>
		</dl>
		
	</div>
	
	
	
	<div class="method-subsection return">
		<h4 class="method-subtitle parameter-title">Return Value</h4>
		<p>true if the UserVariable exists</p>
	</div>
	
	
	
	
	
	<div class="method-subsection discussion-section">
		<h4 class="method-subtitle">Discussion</h4>
		<p>Check if a UserVariable exists</p>
	</div>
	
	
	
	
	
	<div class="method-subsection see-also-section">
		<h4 class="method-subtitle">See Also</h4>
		<ul>
			
			<li><code><p><a href="../Protocols/UserVariable.html">UserVariable</a></p></code></li>
			
		</ul>
	</div>
	
	
	
	<div class="method-subsection declared-in-section">
		<h4 class="method-subtitle">Declared In</h4>
		<code class="declared-in-ref">SFSUser.h</code><br />
	</div>				
	
	
</div>
						
						<div class="section-method">
	<a name="//api/name/getPlayerId:" title="getPlayerId:"></a>
	<h3 class="subsubtitle method-title">getPlayerId:</h3>
	
	
	
	<div class="method-subsection brief-description">
		<p>Return the <b>playerId</b> for the specific Room.
If you don&rsquo;t use multi-room you can use playerId</p>
	</div>		
	
    

	<div class="method-subsection method-declaration"><code>- (NSInteger)getPlayerId:(id&lt;Room&gt;)<em>room</em></code></div>

    
	
	
	
	
	
	
	
	<div class="method-subsection discussion-section">
		<h4 class="method-subtitle">Discussion</h4>
		<p>Return the <b>playerId</b> for the specific Room.
If you don&rsquo;t use multi-room you can use playerId</p>
	</div>
	
	
	
	
	
	
	
	<div class="method-subsection declared-in-section">
		<h4 class="method-subtitle">Declared In</h4>
		<code class="declared-in-ref">SFSUser.h</code><br />
	</div>				
	
	
</div>
						
						<div class="section-method">
	<a name="//api/name/getVariable:" title="getVariable:"></a>
	<h3 class="subsubtitle method-title">getVariable:</h3>
	
	
	
	<div class="method-subsection brief-description">
		<p>Get a UserVariable</p>
	</div>		
	
    

	<div class="method-subsection method-declaration"><code>- (id&lt;UserVariable&gt;)getVariable:(NSString *)<em>varName</em></code></div>

    
	
	<div class="method-subsection arguments-section parameters">
		<h4 class="method-subtitle parameter-title">Parameters</h4>
		
		<dl class="argument-def parameter-def">
			<dt><em>varName</em></dt>
			<dd><p>the name of the variable</p></dd>
		</dl>
		
	</div>
	
	
	
	<div class="method-subsection return">
		<h4 class="method-subtitle parameter-title">Return Value</h4>
		<p>the UserVariable or nil if the variable doesn&rsquo;t exist</p>
	</div>
	
	
	
	
	
	<div class="method-subsection discussion-section">
		<h4 class="method-subtitle">Discussion</h4>
		<p>Get a UserVariable</p>
	</div>
	
	
	
	
	
	<div class="method-subsection see-also-section">
		<h4 class="method-subtitle">See Also</h4>
		<ul>
			
			<li><code><p><a href="../Protocols/UserVariable.html">UserVariable</a></p></code></li>
			
		</ul>
	</div>
	
	
	
	<div class="method-subsection declared-in-section">
		<h4 class="method-subtitle">Declared In</h4>
		<code class="declared-in-ref">SFSUser.h</code><br />
	</div>				
	
	
</div>
						
						<div class="section-method">
	<a name="//api/name/getVariables" title="getVariables"></a>
	<h3 class="subsubtitle method-title">getVariables</h3>
	
	
	
	<div class="method-subsection brief-description">
		<p>Get all the User Variables</p>
	</div>		
	
    

	<div class="method-subsection method-declaration"><code>- (NSArray *)getVariables</code></div>

    
	
	
	
	
	
	
	
	<div class="method-subsection discussion-section">
		<h4 class="method-subtitle">Discussion</h4>
		<p>Get all the User Variables</p>
	</div>
	
	
	
	
	
	<div class="method-subsection see-also-section">
		<h4 class="method-subtitle">See Also</h4>
		<ul>
			
			<li><code><p><a href="../Protocols/UserVariable.html">UserVariable</a></p></code></li>
			
		</ul>
	</div>
	
	
	
	<div class="method-subsection declared-in-section">
		<h4 class="method-subtitle">Declared In</h4>
		<code class="declared-in-ref">SFSUser.h</code><br />
	</div>				
	
	
</div>
						
						<div class="section-method">
	<a name="//api/name/isAdmin" title="isAdmin"></a>
	<h3 class="subsubtitle method-title">isAdmin</h3>
	
	
	
	<div class="method-subsection brief-description">
		<p>Return true if the User is logged in as administrator user</p>
	</div>		
	
    

	<div class="method-subsection method-declaration"><code>- (BOOL)isAdmin</code></div>

    
	
	
	
	
	
	
	
	<div class="method-subsection discussion-section">
		<h4 class="method-subtitle">Discussion</h4>
		<p>Return true if the User is logged in as administrator user</p>
	</div>
	
	
	
	
	
	
	
	<div class="method-subsection declared-in-section">
		<h4 class="method-subtitle">Declared In</h4>
		<code class="declared-in-ref">SFSUser.h</code><br />
	</div>				
	
	
</div>
						
						<div class="section-method">
	<a name="//api/name/isGuest" title="isGuest"></a>
	<h3 class="subsubtitle method-title">isGuest</h3>
	
	
	
	<div class="method-subsection brief-description">
		<p>Return true if the User is logged in as guest user</p>
	</div>		
	
    

	<div class="method-subsection method-declaration"><code>- (BOOL)isGuest</code></div>

    
	
	
	
	
	
	
	
	<div class="method-subsection discussion-section">
		<h4 class="method-subtitle">Discussion</h4>
		<p>Return true if the User is logged in as guest user</p>
	</div>
	
	
	
	
	
	
	
	<div class="method-subsection declared-in-section">
		<h4 class="method-subtitle">Declared In</h4>
		<code class="declared-in-ref">SFSUser.h</code><br />
	</div>				
	
	
</div>
						
						<div class="section-method">
	<a name="//api/name/isJoinedInRoom:" title="isJoinedInRoom:"></a>
	<h3 class="subsubtitle method-title">isJoinedInRoom:</h3>
	
	
	
	<div class="method-subsection brief-description">
		<p>Return true if the User is joined in the specified Room</p>
	</div>		
	
    

	<div class="method-subsection method-declaration"><code>- (BOOL)isJoinedInRoom:(id&lt;Room&gt;)<em>room</em></code></div>

    
	
	
	
	
	
	
	
	<div class="method-subsection discussion-section">
		<h4 class="method-subtitle">Discussion</h4>
		<p>Return true if the User is joined in the specified Room</p>
	</div>
	
	
	
	
	
	
	
	<div class="method-subsection declared-in-section">
		<h4 class="method-subtitle">Declared In</h4>
		<code class="declared-in-ref">SFSUser.h</code><br />
	</div>				
	
	
</div>
						
						<div class="section-method">
	<a name="//api/name/isModerator" title="isModerator"></a>
	<h3 class="subsubtitle method-title">isModerator</h3>
	
	
	
	<div class="method-subsection brief-description">
		<p>Return true if the User is logged in as moderator user</p>
	</div>		
	
    

	<div class="method-subsection method-declaration"><code>- (BOOL)isModerator</code></div>

    
	
	
	
	
	
	
	
	<div class="method-subsection discussion-section">
		<h4 class="method-subtitle">Discussion</h4>
		<p>Return true if the User is logged in as moderator user</p>
	</div>
	
	
	
	
	
	
	
	<div class="method-subsection declared-in-section">
		<h4 class="method-subtitle">Declared In</h4>
		<code class="declared-in-ref">SFSUser.h</code><br />
	</div>				
	
	
</div>
						
						<div class="section-method">
	<a name="//api/name/isPlayerInRoom:" title="isPlayerInRoom:"></a>
	<h3 class="subsubtitle method-title">isPlayerInRoom:</h3>
	
	
	
	<div class="method-subsection brief-description">
		<p>Return true if the User is a Player in the specified Room</p>
	</div>		
	
    

	<div class="method-subsection method-declaration"><code>- (BOOL)isPlayerInRoom:(id&lt;Room&gt;)<em>room</em></code></div>

    
	
	
	
	
	
	
	
	<div class="method-subsection discussion-section">
		<h4 class="method-subtitle">Discussion</h4>
		<p>Return true if the User is a Player in the specified Room</p>
	</div>
	
	
	
	
	
	
	
	<div class="method-subsection declared-in-section">
		<h4 class="method-subtitle">Declared In</h4>
		<code class="declared-in-ref">SFSUser.h</code><br />
	</div>				
	
	
</div>
						
						<div class="section-method">
	<a name="//api/name/isSpectatorInRoom:" title="isSpectatorInRoom:"></a>
	<h3 class="subsubtitle method-title">isSpectatorInRoom:</h3>
	
	
	
	<div class="method-subsection brief-description">
		<p>Return true if the User is a Spectator in the specified Room</p>
	</div>		
	
    

	<div class="method-subsection method-declaration"><code>- (BOOL)isSpectatorInRoom:(id&lt;Room&gt;)<em>room</em></code></div>

    
	
	
	
	
	
	
	
	<div class="method-subsection discussion-section">
		<h4 class="method-subtitle">Discussion</h4>
		<p>Return true if the User is a Spectator in the specified Room</p>
	</div>
	
	
	
	
	
	
	
	<div class="method-subsection declared-in-section">
		<h4 class="method-subtitle">Declared In</h4>
		<code class="declared-in-ref">SFSUser.h</code><br />
	</div>				
	
	
</div>
						
						<div class="section-method">
	<a name="//api/name/isStandardUser" title="isStandardUser"></a>
	<h3 class="subsubtitle method-title">isStandardUser</h3>
	
	
	
	<div class="method-subsection brief-description">
		<p>Return true if the User is logged in as standard user</p>
	</div>		
	
    

	<div class="method-subsection method-declaration"><code>- (BOOL)isStandardUser</code></div>

    
	
	
	
	
	
	
	
	<div class="method-subsection discussion-section">
		<h4 class="method-subtitle">Discussion</h4>
		<p>Return true if the User is logged in as standard user</p>
	</div>
	
	
	
	
	
	
	
	<div class="method-subsection declared-in-section">
		<h4 class="method-subtitle">Declared In</h4>
		<code class="declared-in-ref">SFSUser.h</code><br />
	</div>				
	
	
</div>
						
					</div>
					
					
                    
                    
				</div>
				<div class="main-navigation navigation-bottom">
					<ul>
	<li><a href="../index.html">Index</a></li>
	<li><a href="../hierarchy.html">Hierarchy</a></li>
</ul>
				</div>
				<div id="footer">
					<hr />
					<div class="footer-copyright">
						<p><span class="copyright">&copy; 2014 gotoAndPlay() / A51 Integrated. All rights reserved. (Last updated: 2014-10-13)</span><br />
						
						<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2 (build 963)</a>.</span></p>
						
					</div>
				</div>
			</div>
		</article>
		<script type="text/javascript">
			function jumpToChange()
			{
				window.location.hash = this.options[this.selectedIndex].value;
			}
			
			function toggleTOC()
			{
				var contents = document.getElementById('contents');
				var tocContainer = document.getElementById('tocContainer');
				
				if (this.getAttribute('class') == 'open')
				{
					this.setAttribute('class', '');
					contents.setAttribute('class', '');
					tocContainer.setAttribute('class', '');
					
					window.name = "hideTOC";
				}
				else
				{
					this.setAttribute('class', 'open');
					contents.setAttribute('class', 'isShowingTOC');
					tocContainer.setAttribute('class', 'isShowingTOC');
					
					window.name = "";
				}
				return false;
			}
			
			function toggleTOCEntryChildren(e)
			{
				e.stopPropagation();
				var currentClass = this.getAttribute('class');
				if (currentClass == 'children') {
					this.setAttribute('class', 'children open');
				}
				else if (currentClass == 'children open') {
					this.setAttribute('class', 'children');
				}
				return false;
			}
			
			function tocEntryClick(e)
			{
				e.stopPropagation();
				return true;
			}
			
			function init()
			{
				var selectElement = document.getElementById('jumpTo');
				selectElement.addEventListener('change', jumpToChange, false);
				
				var tocButton = document.getElementById('table_of_contents');
				tocButton.addEventListener('click', toggleTOC, false);
				
				var taskTreeItem = document.getElementById('task_treeitem');
				if (taskTreeItem.getElementsByTagName('li').length > 0)
				{
					taskTreeItem.setAttribute('class', 'children');
					taskTreeItem.firstChild.setAttribute('class', 'disclosure');
				}
				
				var tocList = document.getElementById('toc');
				
				var tocEntries = tocList.getElementsByTagName('li');
				for (var i = 0; i < tocEntries.length; i++) {
					tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false);
				}
				
				var tocLinks = tocList.getElementsByTagName('a');
				for (var i = 0; i < tocLinks.length; i++) {
					tocLinks[i].addEventListener('click', tocEntryClick, false);
				}
				
				if (window.name == "hideTOC") {
					toggleTOC.call(tocButton);
				}
			}
			
			window.onload = init;
			
			// If showing in Xcode, hide the TOC and Header
			if (navigator.userAgent.match(/xcode/i)) {
				document.getElementById("contents").className = "hideInXcode"
				document.getElementById("tocContainer").className = "hideInXcode"
				document.getElementById("top_header").className = "hideInXcode"
			}
			
		</script>
	</body>
</html>